<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Whm_Functions_Abstract</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Whm_Functions_Abstract</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">WHM Abstract Functions</p>
<p class="description"><p>Base class for WHM API Function Classes</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Peter Kumaschow  (pkumaschowATgmail.com)</li>
				<li><span class="field">copyright:</span> <p>Peter Kumaschow 2011 All Rights Reserved</p><p>$Id: Abstract.php 201 2011-11-06 12:11:37Z peterk $</p></li>
				<li><span class="field">abstract:</span> </li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Functions---Abstract.php.html">/Functions/Abstract.php</a> (line <span class="field">18</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../whm-lib/Functions/Whm_Functions_SSL.html">Whm_Functions_SSL</a></td>
					<td>
											WHM SSL Functions
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../whm-lib/Functions/Whm_Functions_Service.html">Whm_Functions_Service</a></td>
					<td>
											WHM Service Functions
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../whm-lib/Functions/Whm_Functions_Dns.html">Whm_Functions_Dns</a></td>
					<td>
											WHM DNS Functions
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../whm-lib/Functions/Whm_Functions_Administration.html">Whm_Functions_Administration</a></td>
					<td>
											WHM API Administration Functions
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../whm-lib/Functions/Whm_Functions_Account.html">Whm_Functions_Account</a></td>
					<td>
											WHM API Account Functions
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../whm-lib/Functions/Whm_Functions_Package.html">Whm_Functions_Package</a></td>
					<td>
											WHM Package Functions
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../whm-lib/Functions/Whm_Functions_Server.html">Whm_Functions_Server</a></td>
					<td>
											WHM Server Functions
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../../whm-lib/Functions/Whm_Functions_Reseller.html">Whm_Functions_Reseller</a></td>
					<td>
											WHM Reseller Functions
										</td>
				</tr>
							</table>
		</div>
	</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$_apiresponse" title="details" class="var-name">$_apiresponse</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$_method" title="details" class="var-name">$_method</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$_params" title="details" class="var-name">$_params</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$_querystring" title="details" class="var-name">$_querystring</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$_rest" title="details" class="var-name">$_rest</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																				
												<div class="method-definition">
											<span class="method-result">Whm_Functions_Abstract</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$config</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$apiresponse</span> = <span class="var-default">'json'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$rest</span> = <span class="var-default">'Whm_Rest_Api'</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$hash</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$host</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#applist" title="details" class="method-name">applist</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#checkParams" title="details" class="method-name">checkParams</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$requiredParams</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$validRequiredParams</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$optionalParams</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$validOptionalParams</span> = <span class="var-default">null</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">object or</span>
										<a href="#decode" title="details" class="method-name">decode</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$results</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getApi" title="details" class="method-name">getApi</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getMethod" title="details" class="method-name">getMethod</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#getParams" title="details" class="method-name">getParams</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getQueryString" title="details" class="method-name">getQueryString</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#post" title="details" class="method-name">post</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#quickpost" title="details" class="method-name">quickpost</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$params</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setApi" title="details" class="method-name">setApi</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$api</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setMethod" title="details" class="method-name">setMethod</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setParams" title="details" class="method-name">setParams</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$params</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setQueryString" title="details" class="method-name">setQueryString</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#validateParams" title="details" class="method-name">validateParams</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$inputParams</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$validParams</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">0</span>], <span class="var-type">array</span>&nbsp;<span class="var-name">$allowedParams</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#version" title="details" class="method-name">version</a>
										()
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$_apiresponse" id="$_apiresponse"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$_apiresponse</span>
						(line <span class="line-number">24</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$_method" id="$_method"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$_method</span>
						(line <span class="line-number">22</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$_params" id="$_params"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$_params</span>
						(line <span class="line-number">23</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$_querystring" id="$_querystring"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$_querystring</span>
						(line <span class="line-number">21</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$_rest" id="$_rest"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$_rest</span>
						(line <span class="line-number">25</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">39</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">constructor sets api return object to xml or json responses</p>
	<ul class="tags">
				<li><span class="field">throws:</span> Exception</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Whm_Functions_Abstract</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$config</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$apiresponse</span> = <span class="var-default">'json'</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$rest</span> = <span class="var-default">'Whm_Rest_Api'</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$hash</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$host</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$username</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$hash</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$host</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$apiresponse</span><span class="var-description">: (json or xml</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$rest</span><span class="var-description">: name of rest class</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$config</span>			</li>
				</ul>
		
			
	</div>
<a name="methodapplist" id="applist"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">applist</span> (line <span class="line-number">279</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">List Available XML/JSON API calls — applist</p>
<p class="description"><p>This function lists all available XML/JSON API functions.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			applist
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodcheckParams" id="checkParams"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">checkParams</span> (line <span class="line-number">211</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">checks params agains known valid params and sets the querystring  to be used in the rest call to whm rest service</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			checkParams
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$requiredParams</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$validRequiredParams</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$optionalParams</span> = <span class="var-default">null</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$validOptionalParams</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$requiredParams</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$validRequiredParams</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$optionalParams</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$validOptionalParams</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddecode" id="decode"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">decode</span> (line <span class="line-number">183</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">return result object decoded appropriately depending on which api  is being used.</p>
	<ul class="tags">
				<li><span class="field">return:</span> false</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object or</span>
		<span class="method-name">
			decode
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$results</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$results</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetApi" id="getApi"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getApi</span> (line <span class="line-number">96</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">get current api type</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getApi
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetMethod" id="getMethod"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getMethod</span> (line <span class="line-number">70</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">get currently set method</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getMethod
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetParams" id="getParams"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getParams</span> (line <span class="line-number">143</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">get params</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getParams
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetQueryString" id="getQueryString"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getQueryString</span> (line <span class="line-number">101</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getQueryString
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodpost" id="post"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">post</span> (line <span class="line-number">154</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">post method call</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			post
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$method</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$params</span>			</li>
				</ul>
		
			
	</div>
<a name="methodquickpost" id="quickpost"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">quickpost</span> (line <span class="line-number">170</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">intended to be used for calling api methods and bypassing  any local validation of the passed in params</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			quickpost
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$params</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$method</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$params</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetApi" id="setApi"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setApi</span> (line <span class="line-number">80</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">set api type (xml or json)</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setApi
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$api</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$api</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetMethod" id="setMethod"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setMethod</span> (line <span class="line-number">61</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">set rest method to call</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setMethod
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$method</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$method</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetParams" id="setParams"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setParams</span> (line <span class="line-number">133</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">set params to be passed to method</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setParams
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$params</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$params</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetQueryString" id="setQueryString"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setQueryString</span> (line <span class="line-number">112</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets query string from supplied params</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setQueryString
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$params</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$params</span>			</li>
				</ul>
		
			
	</div>
<a name="methodvalidateParams" id="validateParams"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">validateParams</span> (line <span class="line-number">243</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">compares two associative arrays and used to validate parameters passed  into a method against an array of acceptable parameter names</p>
<p class="description"><p>returns an array of the outcome, first index indicates validation  success or failure</p><p>true = SUCCESS  false = FAILURE</p><p>If validation fails then the second index will contain an error message</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			validateParams
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$inputParams</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$validParams</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$required</span> = <span class="var-default">0</span>], <span class="var-type">array</span>&nbsp;<span class="var-name">$allowedParams</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$inputParams</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$allowedParams</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$validParams</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$required</span>			</li>
				</ul>
		
			
	</div>
<a name="methodversion" id="version"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">version</span> (line <span class="line-number">266</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">get version of WHM</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			version
		</span>
				()
			</div>
	
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../../whm-lib/Functions/Whm_Functions_Server.html#methodversion">Whm_Functions_Server::version()</a>
								: Returns the version of cPanel/WHM running on the server.
							</li>
				</ul>
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 06 Nov 2011 23:33:11 +1100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>